Get SIP Connections

The Get SIP Connections request retrieves a specific customer SIP Connection. Once you have setup the primary site location, you can add additional branch sites and then provision SBC prefixes for the users at these locations.

URL

Copy 
{{baseUrl}}/api/v2/sitelocation/{sbcSiteGuid}

HTTP Method

GET

Request Headers

Parameter

Type

Description

X-Ovoc-Channel-Id

integer

The Live Platform channel "id". When specified, data retrieval is scoped to only SIP connections that are attached to customers belonging to the specified channel. See Get List of Channels to extract this value.

X-IAM-Account-Id

string

The Live Platform "iamAccountId" of the channel. When specified, data retrieval is scoped to only SIP connections that are attached to customers belonging to the specified channel. See Get List of Channels to extract this value.

Request Parameters

Parameter

Type

Description

sbcSiteGuid

string($uuid)

The unique id for the SIP Connection (site location). Extract this value using Get Details for Specific Service request by searching in the response for the matching site name under the Site Location array 'id' value. See example below:

Copy 
"Id": "806664bf-5380-44b6-b7ee-ab9c443cc284",
"ShortName": "BradTest3",
"FullName": "BradTest3",
"LicenseType": 2,
"SiteLocation": [
{
"id": "0ce9ce2f-04e2-4746-b436-f68b8ad82a9a",
"name": "GSBGHDLVPZBSS",
"sbcId": 5,
"sbcDeploymentState": "Deployed"
},
{
"id": "548b7e8f-9a27-47f4-8c5b-382d4e4c5a3b",
"name": "Brad1010",
"sbcId": 5,
"sbcDeploymentState": "Deployed"
}
]

Example Response

Copy 
{
    "tenantId": "a8401c93-31f5-439c-a21d-bc6b87ceee67",
    "m365DeploymentState": null,
    "sbcDeploymentState": 3,
    "siteName": "GSDXBFAVYBWZF",
    "onlinePstnGateway": null,
    "sbcInfo": {
        "sbcConfigurationType": 1,
        "cacProfile": "",
        "carrierHostName": null,
        "carrierId": "SIPTrunk",
        "carrierMainLine": null,
        "carrierUserName": null,
        "flagConfigureSbc": true,
        "sbcId": 8,
        "sbcScripts": {
            "onboardingScript": 5461228,
            "cleanupScript": 5461229,
            "customerVariables": {
                "Carrier-ProxyAddress": "10.0.0.0",
                "Carrier-SIPPort": "5060",
                "Carrier-TransportType_UDP-TCP-TLS": "TCP",
                "Carrier-MediaSecurity_Secure-Unsecure": "Unsecure"
            }
        }
    },
    "m365Info": {
        "m365Scripts": null
    },
    "pendingTasks": []
}

HTTP Responses

■ 200 OK

Parameter

Type

Description

tenantId

string

Microsoft tenant subscription Id

m365DeploymentState

integer

One of the following values:

■ Draft=0
■ Submitted=1
■ Deploying=2
■ Deployed=3
■ Error=4
■ ReadyForDeployment=5
■ ReadyForRemove =6
■ Removing=7
■ Removed=8

sbcDeploymentState

integer

One of the following values:

■ Draft=0
■ Submitted=1
■ Deploying=2
■ Deployed=3
■ Error=4
■ ReadyForDeployment=5
■ ReadyForRemove=6
■ Removing=7
■ Removed=8

siteName

string

Site location name.

sbcInfo

list array

List array including the following parameters:

■ sbcConfigurationType
■ cacProfile
■ carrierHostName
■ carrierId
■ carrierMainLine
■ carrierUserName
■ sbcId
■ sbcScripts
✔ onboardingScript
✔ cleanupScript
✔ customerVariables

sbcConfigurationType

integer

One of the following values: 1- SIP Trunk; 2- IP-PBX; 3-BYOC (Bring-Your-Own-Carrier)

Cac Profile

string

Defines the desired number of Call Admission Control (CAC) call sessions. For example, "10 sessions". This value also represents the name of the CAC profile.

carrierHostName

string

Defines the Address of Record (AOR) host name. The host name appears in SIP REGISTER From/To headers as ContactUser@HostName.

carrierId

string

Carrier name e.g. SIP Trunk

carrierMainLine

string

MainLine (Contact User): Defines the AOR username. This appears in REGISTER From/To headers as ContactUser@HostName

carrierUserName

string

Defines the digest MD5 Authentication username. The valid value is a string of up to 60 characters. By default, no value is defined.

sbcId

integer

Id of the SBC in the Live Cloud database.

sbcScripts

list array

List array including the following parameters:

■ onboardingScript
■ cleanupScript
■ customerVariables

onboardingScript

integer

Database value of the SBC Onboarding script.

cleanupScript

integer

Database value of the SBC Cleanup script.

customerVariables

integer

Database value of the SBC customer-defined variables.

m365Info

list array

List array including the m365Scripts list.

m365Scripts

list array

List array including the following parameters:

■ flagConfigureM365Routing
■ onboardingScript
■ cleanupScript
■ customerVariables

onboardingScript

integer

Live Platform database value of the M365 Onboarding script.

cleanupScript

integer

Live Platform database value of the M365 Cleanup script.

customerVariables

integer

Live Platform database values of the M365 customer variables defined in the database.
■ 400 Bad Request

Parameter

Type

Description/Examples

errors

string

 Text description of the error.

type

string

"https://tools.ietf.org/html/rfc7231#section-6.5.1"

title

string

Email title. For example "One or more validation errors occurred."

status

error code

HTML error code i.e. 400

detail

string

Additional error details.

traceId

string

Error trace Id

instance

string

Error instance

errorTicket

string

This field may not appear for all return codes.

errorCode

string

This field may not appear for all return codes.

additionalProp1

string

Custom Script variable argument. For example "CacProfile": "5 sessions"

additionalProp2

string

Custom Script argument. For example, ProxySet": "SIPTrunk",

additionalProp3

string

Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"
■ 403 Forbidden: this error is raised when the site location id specified in the URL is not attached to a customer belonging to the channel as specified in the request header values X-Ovoc-Channel-Id or X-IAM-Account-Id.

Parameter

Type

Description/Examples

errors

string

 Text description of the error.

type

string

"https://tools.ietf.org/html/rfc7231#section-6.5.1"

title

string

Email title. For example "One or more validation errors occurred."

status

error code

HTML error code i.e. 400

detail

string

Additional error details.

traceId

string

Error trace Id

instance

string

Error instance

errorTicket

string

This field may not appear for all return codes.

errorCode

string

This field may not appear for all return codes.

additionalProp1

string

Custom Script variable argument. For example "CacProfile": "5 sessions"

additionalProp2

string

Custom Script argument. For example, ProxySet": "SIPTrunk",

additionalProp3

string

Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"
■ 404 Not Found

Parameter

Type

Description/Examples

errors

string

 Text description of the error.

type

string

"https://tools.ietf.org/html/rfc7231#section-6.5.1"

title

string

Email title. For example "One or more validation errors occurred."

status

error code

HTML error code i.e. 400

detail

string

Additional error details.

traceId

string

Error trace Id

instance

string

Error instance

errorTicket

string

This field may not appear for all return codes.

errorCode

string

This field may not appear for all return codes.

additionalProp1

string

Custom Script variable argument. For example "CacProfile": "5 sessions"

additionalProp2

string

Custom Script argument. For example, ProxySet": "SIPTrunk",

additionalProp3

string

Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"
■ 409 Conflict

Parameter

Type

Description/Examples

errors

string

 Text description of the error.

type

string

"https://tools.ietf.org/html/rfc7231#section-6.5.1"

title

string

Email title. For example "One or more validation errors occurred."

status

error code

HTML error code i.e. 400

detail

string

Additional error details.

traceId

string

Error trace Id

instance

string

Error instance

errorTicket

string

This field may not appear for all return codes.

errorCode

string

This field may not appear for all return codes.

additionalProp1

string

Custom Script variable argument. For example "CacProfile": "5 sessions"

additionalProp2

string

Custom Script argument. For example, ProxySet": "SIPTrunk",

additionalProp3

string

Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"
■ 500 Internal Server Error